Data ONTAP SMI-S Agent README for LINUX

CONTENTS

    1.0 - Glossary

    2.0 - What is a SMI-S Agent

    3.0 - System Requirements

    4.0 - Installation

    5.0 - Quickstart Instructions

    6.0 - Installed Components

    7.0 - Managing configuration settings

    8.0 - Enabling Authentication

    9.0 - Generating a Self-Signed Certificate for the CIMOM

------------------------------------------------------------------

1.0 Glossary

    CIM - Common Information Model
    CIMOM - CIM Object Manager
    DMTF - Distributed Management Task Force
    SLP - Service Location Protocol
    SMI-S - Storage Management Initiative Specification
    SO - Shared Objects
    WBEM - Web-Based Enterprise Management

------------------------------------------------------------------

2.0 What is a SMI-S Agent

    The SMI-S Agent is comprised of several components based on 
    WBEM and includes a CIMOM and a number of "providers"--
    Shared Objects which provide the underlying device management 
    functionality.

    WBEM clients discover the CIMOM using SLP, and query it
    for objects modeled in the CIM modeling language using the
    CIM/XML encoding over the CIM/HTTP protocol. The CIMOM in
    turn loads the appropriate provider shared objects and queries the
    devices using device-specific APIs for the requested 
    information. Active management works in much the same way.

    The DMTF currently oversees the above-mentioned technology 
    standards. For more information, see

        http://www.dmtf.org
----------------------------------------------------------------

3.0 System Requirements
  
    3.1 - Supported Operating Systems

        RedHat Enterprise Linux ES, v4 (update 3 or later) for x86 (32-bit and 64-bit)
        RedHat Enterprise Linux AS, v4 (update 3 or later) for x86 (32-bit and 64-bit)
        RedHat Enterprise Advanced Platform v5 for x86 (32-bit and 64-bit)
        SUSE Linux Enterprise Server, v10 (32-bit)
        SUSE Linux Enterprise Server, v11 SP1 (32-bit)

    3.2 - Additional Software Requirements

       a) Uncompress is required for the installation archive.
          Install it in /usr/bin/ directory.

------------------------------------------------------------------

4.0 Installation

    4.1 - Package installation

        Run the following commands as user "root" to install the
        SMI-S agent.

              tar xvf ./smisagent-4-0.tar
              ./install_smisproxy [-f] [-s] [-k]

        The SMI-S Agent is installed into /usr/ontap/smis.
        All temporary files, even the install_smisproxy script,
        are deleted at the end of this process unless -k is
        specified as an option to the script. 
	
	If doing a reinstallation, -f should be specified to
	overwrite a previously installed version of the SMI-S Agent. 
	Specify -s during reinstallation to keep the SLP configuration
	files. 

-------------------------------------------------------------------------

5.0 Quick Start Instructions

    5.1 - Starting the SMI-S Agent

        As user root,

        cd /installation_directory/ontap/smis/pegasus/bin
        Run "smis cimserver start" command.

    5.2 - Add one or more storage systems to the repository

        Execute
            /installation_directory/ontap/smis/pegasus/bin/smis \
                add <storage_sys> <storage_sys_user> \
                <storage_sys_pwd> [-t http|https]

        See section 6 below for more uses of the smis command.

    5.3 - Stopping the SMI-S Agent

        /installation_directory/ontap/smis/pegasus/bin/smis cimserver stop

    5.4 - Removing the SMI-S Agent
        After stopping the server, run
        /installation_directory/ontap/smis/pegasus/bin/uninstall_smisproxy command.

----------------------------------------------------------------

6.0 Installed Components

    6.1 - SLP Services

        The CIM Server advertises itself via SLP. To start or stop
        slpd daemon use:
          /installation_directory/ontap/smis/pegasus/bin/smis slpd start|stop

        SLP related tools are available in the /installation_directory/ontap/smis/pegasus/bin
	directory. Upon starting the slpd daemon and the Agent, one
        can verify SLP advertisement with the included slptool.
        To probe for advertised wbem based CIMOMs use:

          /installation_directory/ontap/smis/pegasus/bin/slptool findsrvs service:wbem

    6.2 - SMIS tool

        The "smis" tool is used to start or stop slpd daemon, start or stop cimserver,
        manipulate storage systems via the CIMOM, and display information from the CIMOM's
        interop namespace. The smis tool lives in /installation_directory/ontap/smis/pegasus/bin
        directory. There are several options:

            smis -help (lists command summary)

            smis -help examples (lists usage examples)

            smis -help command (lists help for given command)

        Commands:

                add          Add Storage Systems to the CIMOM Repository
                             smis <add> <storage_sys> \
                                  <storage_sys_user> <storage_sys_pwd> [-t http|https]
                             "smis add ntap-fas2040-1 root passw0rd1!"

                cimom        Enumerate CIM_ObjectManager
                             smis cimom
                             "smis cimom"

                config       Display cimserver configuration
                             smis config show

                cimserver    start/stop/status control for the cimserver
                             smis cimserver <start|stop|status>

                class        Query CIM classes by namespace
                             smis <class> <name_space> \
                             {<niall> | <ei|ni|gi|gc> <class_name>} [-t http|https]

                             "smis class root/ontap ni \
                             CIM_ComputerSystem"

                             "smis class root/ontap niall"

                crp          Enumerate CIM_RegisteredProfile
                             smis <crp> [-t http|https]
                             "smis crp"

                crsp         Enumerate CIM_RegisteredSubProfile
                             smis <crsp> [-t http|https]
                             "smis crsp"

                delete       Delete Storage Systems from the CIMOM Repository
                             smis <delete> <storage_sys> \
                                  [-t http|https]
                             "smis delete ntap-fas2040-1"

                disks        Display disks on managed storage device(s)
                             smis <disks> [-t http|https]
                             "smis disks"

                exports      Display NFS and CIFS exports on managed storage device(s)
                             smis <exports> [-t http|https]
                             "smis exports"

                initiators   Display mapped initiators on managed storage device(s)
                             smis <initiators> [-t http|https]
                             "smis initiators"

                licensed     Display licensed features on managed storage device(s)
                             smis <licensed> [-t http|https]
                             "smis licensed"

                list         Display Storage Systems in the CIMOM Repository
                             smis <list> [-t http|https]
                             "smis list"

                luns         Display exported luns on managed storage device(s)
                             smis <luns> [-t http|https]
                             "smis luns"

                namespaces   Display registered namespaces"
                             smis <namespaces> [-t http|https]"

                pools        Display storage pools on managed storage device(s)
                             smis <pools> [-t http|https]
                             "smis pools"

                slpd         start/stop the slpd daemon
                             smis slpd <start|stop>

                version      Display Data ONTAP SMI-S Agent version
                             smis <version> [-t http|https]
                             "smis version"

                volumes      Display volumes on managed storage device(s)
                             smis <volumes> [-t http|https]
                             "smis volumes"

            Transport is specified with '-t http|https'. Default is https.

----------------------------------------------------------------

7.0 Displaying configuration settings

    Cimserver configuration settings can be viewed using the following command:
    smis config show

----------------------------------------------------------------

8.0 Enabling Authentication

    Authentication is not enabled by default. As user "root", run the
    following commands to enable the authentication.

        a) Make sure that the Agent is running.

        b) Enable user authentication using the cimconfig command.

            cd installation_directory/ontap/smis/pegasus/bin
            cimconfig -p -s enableAuthentication=true

        c) Restart the Agent/cimserver using smis command.
             smis cimserver restart

        d) Adding a user
             cimuser -a -u user1 -w <password>

             The credentials specified above should be used to connect to the SMI-S Agent.

----------------------------------------------------------------

9.0 Generating a Self-Signed Certificate for the CIMOM

    By default, we enable HTTP/HTTPS protocols and install a Self-Signed
    Certificate for the CIMOM in /installation_directory/ontap/smis/pegasus directory.
    If you don't want to use the default certificate, you can generate your own
    Self-Signed Certificate for the CIMOM using the following steps.

    a) Download the openssl from http://www.openssl.org and install it.

    b) Go to openssl bin directory and generate a private RSA key using the
       following command.

       openssl genrsa -out cimom.key 2048

    c) Generate a certificate request using the following command.

       openssl req -new -key cimom.key -out cimom.csr

       You are about to be asked to enter information that will be incorporated
       into your certificate request.
       What you are about to enter is what is called a Distinguished Name or a DN.
       There are quite a few fields but you can leave some blank
       For some fields there will be a default value,
       If you enter '.', the field will be left blank.
       -----
       Country Name (2 letter code) [AU]:US
       State or Province Name (full name) [Some-State]:California
       Locality Name (eg, city) []:Sunnyvale
       Organization Name (eg, company) [Internet Widgets Pvt Ltd]:NetApp
       Organizational Unit Name (eg, section) []:Engineering
       Common Name (eg, Your name or Your server's hostname) []: testuser
       Email Address []: testuser@netapp.com
       Please enter the following 'extra' attributes
       to be sent with your certificate request
       A challenge password []:sundance
       An optional company name []:NetApp, Inc.

    d) Generate the Self-Signed Certificate using the following command.

       openssl x509 -in cimom.csr -out cimom.cert -req -signkey cimom.key -days 1095

       The certificate date range will start at today's date and run for the number of
       days specified. Typically the Common Name must match the server name used to
       connect exactly but we are not checking this because it precludes using a
       common certificate on multiple machines and leads to hard to diagnose
       connection issues.

    e) Copy the cimom.key and cimom.cert files to the
       /installation_directory/ontap/smis/pegasus directory.

